Get all business lines under a legal entity

get/legalEntities/{id}/businessLines

API Version

Returns the business lines owned by a legal entity.

Endpoint destination URL

https://kyc-test.adyen.com/lem/v4/legalEntities/{id}/businessLines

Path Parameters

Required

Optional

The unique identifier of the legal entity.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
businessLinesarray[object]
List of business lines.
idstring
The unique identifier of the business line.
industryCodestring
A code that represents the industry of the legal entity for marketplaces or platforms. For example, 4431A for computer software stores.
legalEntityIdstring
Unique identifier of the legal entity that owns the business line.
problemsarray[object]
The verification errors related to capabilities for this supporting entity.
entityobject
documentsarray[string]
List of document IDs corresponding to the verification errors from capabilities.
idstring
ownerobject
documentsarray[string]
List of document IDs corresponding to the verification errors from capabilities.
idstring
typestring
typestring
verificationErrorsarray[object]
capabilitiesarray[string]
Contains key-value pairs that specify the actions that the legal entity can do in your platform. The key is a capability required for your integration. For example, issueCard for Issuing.The value is an object containing the settings for the capability.
codestring
The general error code.
messagestring
The general error message.
remediatingActionsarray[object]
An object containing possible solutions to fix a verification error.
codestring
messagestring
subErrorsarray[object]
An array containing more granular information about the cause of the verification error.
capabilitiesarray[string]
Contains key-value pairs that specify the actions that the legal entity can do in your platform. The key is a capability required for your integration. For example, issueCard for Issuing.The value is an object containing the settings for the capability.
codestring
The general error code.
messagestring
The general error message.
typestring
The type of error.

Possible values:

invalidInput

dataMissing

pendingStatus

rejected

dataReview

remediatingActionsarray[object]
An object containing possible solutions to fix a verification error.
codestring
messagestring
typestring
The type of error.

Possible values:

invalidInput

dataMissing

pendingStatus

rejected

dataReview

salesChannelsarray[string]
A list of channels where goods or services are sold.

Possible values: pos, posMoto, eCommerce, ecomMoto, payByLink.

Required only in combination with the service paymentProcessing.
servicestring
The service for which you are creating the business line.

Possible values:

paymentProcessing

issuing

banking

sourceOfFundsobject
Contains information about the source of your user's funds. Required only if the service is banking or issuing.
adyenProcessedFundsboolean
Indicates whether the funds are coming from transactions processed by Adyen. If false, the type is required.
amountobject
Required if type is business, assetSale, gamblingWinnings or inheritance.

For type business, provide the annual turn over of the business. For type assetSale, gamblingWinnings or inheritance, provide the amount of the funds.
currencystring
The type of currency. Must be EUR (or EUR equivalent)
valueinteger
Total value of amount. Must be >= 0
assetMonthsHeldinteger
The number of months that the asset has been in possession of the user.

For example, if the source of funds is of type cryptocurrencyIncome then assetMonthsHeld is the number of months the user has owned the cryptocurrency.
cryptocurrencyExchangestring
The cryptocurrency exchange where the funds were acquired. Required if type is cryptocurrencyIncome.
dateOfFundsReceivedstring
The date the funds were received, in YYYY-MM-DD format. Required if type is donations or inheritance.
dateOfSourceEventstring
The date the funds were received, in YYYY-MM-DD format. Required if type is assetSale or gamblingWinnings.

For example, if the source of funds is of type assetSale, the dateOfSourceEvent is the date of the sale. If the source of funds is of type gamblingWinnings, the dateOfSourceEvent is the date of winnings.
descriptionstring
Text describing the source of funds. Required if type is business or assetSale.

For example, for type business, provide a description of where the business transactions come from, such as payments through bank transfer. For type assetSale, provide a description of the asset. For example, the address of a residential property if it is a property sale.
financiersarray[object]
Information about the financiers. Required if type is thirdPartyFunding.
amountobject
The amount of the funds the financier provided.
currencystring
The type of currency. Must be EUR (or EUR equivalent)
valueinteger
Total value of amount. Must be >= 0
firstNamestring
The financier's first name.
lastNamestring
The financier's last name.
locationstring
The location of the financier.
originatorLegalEntityIdstring
The legal entity ID representing the originator of the source of funds. Required if type is donations or inheritance.

For example, if the source of funds is inheritance, then originatorOfFundsReference should be the legal entity reference of the benefactor.
originatorSourceOfFundsTypestring
Where the funds originated from. Required if type is donations or inheritance.

For example, if the source of funds is donations, then originatorSourceOfFundsType must be the type of the donated funds.
purposestring
The reason for receiving the funds. Required if type is donations.
relationshipstring
The relationship of the originator of the funds to the recipient. Required if type is donations or inheritance.
typestring
The type of the source of funds.

Possible values:

business

employment

donations

inheritance

financialAid

rentalIncome

dividendIncome

royaltyIncome

thirdPartyFunding

pensionIncome

insuranceSettlement

cryptocurrencyIncome

assetSale

loans

gamblingWinnings

websitestring
The location of the gambling site. Required if type is gamblingWinnings.

If the source of funds is online gambling, provide the website of the gambling company.
webDataarray[object]
List of website URLs where your user's goods or services are sold. When this is required for a service but your user does not have an online presence, provide the reason in the webDataExemption object.
webAddressstring
The URL of the website or the app store URL.
webAddressIdstring
The unique identifier of the web address.
webDataExemptionobject
The reason why the web data is not provided.
reasonstring
The reason why the web data was not provided. Possible value: noOnlinePresence.
400 - Bad Request
A problem reading or understanding the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
401 - Unauthorized
Authentication required.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
403 - Forbidden
Insufficient permissions to process the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
422 - Unprocessable Entity
A request validation error.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
500 - Internal Server Error
The server could not process the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.

Get all business lines under a legal entity

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error